Vcenter VM ComputePlacementSpec

The Vcenter VM ComputePlacementSpec schema contains information used to place a virtual machine on compute resources.

JSON Example

{
    "resource_pool": "string",
    "host": "string",
    "cluster": "string"
}

string

resource_pool

Optional

Resource pool into which the virtual machine should be placed.

This property is currently required if both host and cluster are missing or null. In the future, if this property is missing or null, the system will attempt to choose a suitable resource pool for the virtual machine; if a resource pool cannot be chosen, the virtual machine creation operation will fail.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool.

string

host

Optional

Host onto which the virtual machine should be placed.

If host and resource_pool are both specified, resource_pool must belong to host.

If host and cluster are both specified, host must be a member of cluster.

This property may be missing or null if resource_pool or cluster is specified. If missing or null, the system will attempt to choose a suitable host for the virtual machine; if a host cannot be chosen, the virtual machine creation operation will fail.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.

string

cluster

Optional

Cluster into which the virtual machine should be placed.

If cluster and resource_pool are both specified, resource_pool must belong to cluster.

If cluster and host are both specified, host must be a member of cluster.

If resource_pool or host is specified, it is recommended that this property be missing or null.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ClusterComputeResource.